feat: add support for Netlify Edge Functions #2866

ascorbic · 2022-04-19T14:44:31Z

This PR adds a Remix adapter for the beta release of Netlify Edge Functions. It is implemented as a package @remix-run/netlify-edge and uses the Deno runtime with some small but important changes. Most significantly, this adapter bundles all of the generated server code (except the adapter itself), and by default expects that user code will use regular node-style imports rather than URL imports as expected by Deno. The generated server code is Deno-compatible, and can be used directly as a Netlify Edge Function. It is emitted into .netlify/edge-functions/server.js. It also generates a manifest in .netlify/edge-functions/manifest.json. The Deno runtime code is currently inlined inside the package, because it isn't published anywhere at present.

This PR also adds some tooling to make life easier when working on Deno and Node code in the same repo. This includes defining deno.enablePaths in the VS Code settings, so that it only runs on Deno code, and adding an import map so that Deno code that uses bare imports (such as the imports of build) works as expected.

It extends the default Netlify template, adding a remix.init script that asks if the user want to use Edge Functions, and setting the project up accordingly.

Closes: #

Docs
Tests

fix: add import map fix: declare globals fix: add types to server declaration fix: tidying up chore: remove deprecated magic imports refactor: change Netlify template to support both runtimes refactor: move edge functions template into examples feat: add edge manifest

feat: add import map fix: resolve path for runtime

MichaelDeBoey · 2022-04-19T15:56:57Z

packages/remix-dev/compiler.ts

+    config.serverBuildTarget === "deno" ||
+    config.serverBuildTarget === "netlify-edge"


This could be simplified to

["deno", "netlify-edge"].includes(config.serverBuildTarget]

MichaelDeBoey · 2022-04-19T16:02:14Z

packages/remix-netlify-edge/mod.ts

+  SessionData,
+  SessionIdStorageStrategy,
+  SessionStorage,
+} from "https://esm.sh/@remix-run/server-runtime@1.4.1";


Should we keep this or change it to something like we have in the remix-deno package?

Suggested change

} from "https://esm.sh/@remix-run/server-runtime@1.4.1";

} from "https://esm.sh/@remix-run/server-runtime?pin=v77";

MichaelDeBoey · 2022-04-19T16:03:58Z

packages/remix-netlify-edge/mod.ts

+  isSession,
+  json,
+  redirect,
+} from "https://esm.sh/@remix-run/server-runtime@1.4.1";


Suggested change

} from "https://esm.sh/@remix-run/server-runtime@1.4.1";

} from "https://esm.sh/@remix-run/server-runtime?pin=v77";

MichaelDeBoey · 2022-04-19T16:04:29Z

packages/remix-netlify-edge/server.ts

+import type { ServerBuild } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";
+import { createRequestHandler as createRemixRequestHandler } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";


These are referencing older versions.

We should at least update to latest version

Suggested change

import type { ServerBuild } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";

import { createRequestHandler as createRemixRequestHandler } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";

import type { ServerBuild } from "https://esm.sh/@remix-run/server-runtime@1.4.1?pin=v77";

import { createRequestHandler as createRemixRequestHandler } from "https://esm.sh/@remix-run/server-runtime@1.4.1?pin=v77";

Or remove version number all together

Suggested change

import type { ServerBuild } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";

import { createRequestHandler as createRemixRequestHandler } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";

import type { ServerBuild } from "https://esm.sh/@remix-run/server-runtime?pin=v77";

import { createRequestHandler as createRemixRequestHandler } from "https://esm.sh/@remix-run/server-runtime?pin=v77";

MichaelDeBoey · 2022-04-19T16:08:08Z

templates/netlify/remix.init/package-lock.json

@@ -0,0 +1,917 @@
+{


We should probably delete this file, as none of the templates have one

MichaelDeBoey · 2022-04-19T16:17:48Z

packages/remix-netlify-edge/package.json

+    "index.js"
+  ],
+  "peerDependencies": {
+    "@remix-run/server-runtime": "*"


This should probably go into dependencies I think? 🤔

MichaelDeBoey · 2022-04-19T16:19:19Z

templates/netlify/app/entry.server.tsx

@@ -1,4 +1,4 @@
-import type { EntryContext } from "@remix-run/node";
+import type { EntryContext } from "@remix-run/server-runtime";


I think this should only be the case when choosing for "Netlify Edge Functions", so this file should be overridden by remix.init? 🤔

MichaelDeBoey · 2022-04-19T16:19:26Z

templates/netlify/app/root.tsx

@@ -1,4 +1,4 @@
-import type { MetaFunction } from "@remix-run/node";
+import type { MetaFunction } from "@remix-run/server-runtime";


I think this should only be the case when choosing for "Netlify Edge Functions", so this file should be overridden by remix.init? 🤔

MichaelDeBoey · 2022-04-19T16:21:00Z

templates/netlify/package.json

@@ -10,7 +10,7 @@
    "start": "cross-env NODE_ENV=production netlify dev"
  },
  "dependencies": {
-    "@netlify/functions": "^0.10.0",
+    "@netlify/functions": "latest",
    "@remix-run/netlify": "*",


We should probably replace this with @remix-run/netlify-edge when choosing for "Netlify Edge Functions" in remix.init

MichaelDeBoey · 2022-04-19T16:21:03Z

templates/netlify/package.json

@@ -10,7 +10,7 @@
    "start": "cross-env NODE_ENV=production netlify dev"
  },
  "dependencies": {
-    "@netlify/functions": "^0.10.0",
+    "@netlify/functions": "latest",
    "@remix-run/netlify": "*",
    "@remix-run/node": "*",


We should probably replace this with @remix-run/server-runtime when choosing for "Netlify Edge Functions" in remix.init

github-actions · 2022-04-26T07:05:38Z

🤖 Hello there,

We just published version v0.0.0-nightly-a9f2dde-20220426 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

github-actions · 2022-04-27T07:05:53Z

🤖 Hello there,

We just published version v0.0.0-nightly-cc69c1b-20220427 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

github-actions · 2022-04-27T16:24:48Z

🤖 Hello there,

We just published version v1.4.2-pre.0 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

github-actions · 2022-04-27T19:45:10Z

🤖 Hello there,

We just published version v1.4.2 which includes this pull request. If you'd like to take it for a test run please try it out and let us know what you think!

Thanks!

ascorbic added 13 commits April 8, 2022 13:49

feat: add remix.init to Netlify template

ef68922

feat: add import map fix: resolve path for runtime

chore: remove netlify edge example

0964557

fix: handle static files

359aad7

fix: import map paths

97fea3a

chore: add comment re deno runtime

931f11f

chore: move deno runtime into subdir

be7932e

chore: publish netlify edge module as untranspiled TS

36fc06f

chore: switch to standard inquirer list

5036dd9

Merge branch 'tender-stonebraker' into mk/netlify-edge

32fdeba

fix: prompt wording

6620dae

chore: target tagged package

e310d92

chore: update internal deps

a7ed7d3

remix-cla-bot bot added the CLA Signed label Apr 19, 2022

chaance merged commit a480c9a into remix-run:tender-stonebraker Apr 19, 2022

MichaelDeBoey reviewed Apr 19, 2022

View reviewed changes

hi-ogawa mentioned this pull request Apr 29, 2022

chore: netlify edge experiment hi-ogawa/ytsub-v3#54

Closed

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add support for Netlify Edge Functions #2866

feat: add support for Netlify Edge Functions #2866

ascorbic commented Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

MichaelDeBoey Apr 19, 2022

github-actions bot commented Apr 26, 2022

github-actions bot commented Apr 27, 2022

github-actions bot commented Apr 27, 2022

github-actions bot commented Apr 27, 2022

		config.serverBuildTarget === "deno" \|\|
		config.serverBuildTarget === "netlify-edge"

	} from "https://esm.sh/@remix-run/server-runtime@1.4.1";
	} from "https://esm.sh/@remix-run/server-runtime?pin=v77";

		import type { ServerBuild } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";
		import { createRequestHandler as createRemixRequestHandler } from "https://esm.sh/@remix-run/server-runtime@1.3.5?pin=v77";

		@@ -1,4 +1,4 @@
		import type { EntryContext } from "@remix-run/node";
		import type { EntryContext } from "@remix-run/server-runtime";

		@@ -1,4 +1,4 @@
		import type { MetaFunction } from "@remix-run/node";
		import type { MetaFunction } from "@remix-run/server-runtime";

feat: add support for Netlify Edge Functions #2866

feat: add support for Netlify Edge Functions #2866

Conversation

ascorbic commented Apr 19, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Apr 26, 2022

github-actions bot commented Apr 27, 2022

github-actions bot commented Apr 27, 2022

github-actions bot commented Apr 27, 2022